docs(enterprise): expand Functions reference with table functions, WASM tier, and distribution gating#104
Open
lukekim wants to merge 1 commit into
Open
Conversation
…er, and distribution gating - Document `kind: table` user-defined table functions (UDTFs) with SQL, Remote HTTP, and WebAssembly tiers, including how to declare and call them and how `signature.tables` passes relations through. - Add the WebAssembly tier (from: wasm) with its sandbox params, ABI contract, and supported source/module modes. - Note that the HTTP and WASM tiers are gated behind the http-functions and wasm-functions cargo features — shipped by default in Enterprise and Cloud distributions, local-build-only for open source. Refreshed the Distribution Availability matrix accordingly. - Update the Remote tier wire contract to cover table arguments and the combined args + tables request shape, and update the params table with batch_concurrency, max_response_bytes, and max_rows. - Expand the Supported Types reference to include list, large_list, struct, decimal, decimal256, large_utf8, large_binary, and timestamps with timezones, and clarify per-tier serialization semantics. - Add `enabled` to the Function schema reference and clarify per-tier body / body_ref rules. - List User-Defined Functions under Features in the Enterprise sidebar.
lukekim
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expands the Enterprise User-Defined Functions docs to match the current shipping behaviour, calls out which tiers are Enterprise-/Cloud-only, and surfaces Functions in the Enterprise sidebar.
kind: table) are now documented for SQL, Remote HTTP, and WebAssembly tiers — declaration, call sites,signature.tablesfor passing relations, and the per-tier wire shapes.from: wasm) is introduced with its sandbox params (module/source,entrypoint,fuel,max_memory_bytes, …) and Arrow IPC ABI.getting-started/distributions.mdhas matching rows.batch_concurrency,max_response_bytes, andmax_rows. The "batches are issued sequentially" claim is removed.list,large_list,struct,decimal(128|256),large_utf8,large_binary, and timestamps with timezones, with tier-specific serialization notes.enabledfield and clarifies the per-tierbody/body_refrules (required for SQL, forbidden for HTTP, optional table-input source for WASM).enterprise/SUMMARY.md→ Features so the page is reachable from navigation.Pages updated
enterprise/features/functions.md— major expansion: table functions, WebAssembly tier, Enterprise/OSS gating callouts, refreshed params and types tables, refined limitations.enterprise/SUMMARY.md— Functions added under Features.enterprise/getting-started/distributions.md— added "HTTP user-defined functions" and "WASM user-defined functions" rows to the Distribution Availability matrix and a short pointer paragraph.Verification
http-functionsandwasm-functionsare in the Enterprise default feature list and not in the OSS default.{% hint %}) used throughout — no Docusaurus:::blocks introduced..mdsuffixes (../getting-started/distributions.md,distributed-query.md).enterprise/SUMMARY.mdupdated for the new sidebar entry.